<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>chigraph: lib/core/include/chi/ModuleCache.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="chigraphDoxygenIcon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">chigraph
   &#160;<span id="projectnumber">master</span>
   </div>
   <div id="projectbrief">Systems programming language written for beginners in LLVM</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ModuleCache_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">ModuleCache.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="ModuleCache_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef CHI_MODULE_CACHE_HPP</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#define CHI_MODULE_CACHE_HPP</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="core_2include_2chi_2Fwd_8hpp.html">chi/Fwd.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;boost/filesystem/path.hpp&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;ctime&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacechi.html">chi</a> {</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structchi_1_1ModuleCache.html">   16</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structchi_1_1ModuleCache.html#a471e0c0822bccdd1fa5ed1bc34f7d641">   18</a></span>&#160;    <span class="keyword">explicit</span> <a class="code" href="structchi_1_1ModuleCache.html#a471e0c0822bccdd1fa5ed1bc34f7d641">ModuleCache</a>(<a class="code" href="structchi_1_1Context.html">Context</a>&amp; ctx) : mContext{&amp;ctx} {}</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="structchi_1_1ModuleCache.html#a5ebdd2fe3e0835df8abfb0efe642dad3">~ModuleCache</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="comment">// No copy or move</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <a class="code" href="structchi_1_1ModuleCache.html#a471e0c0822bccdd1fa5ed1bc34f7d641">ModuleCache</a>(<span class="keyword">const</span> <a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <a class="code" href="structchi_1_1ModuleCache.html#a471e0c0822bccdd1fa5ed1bc34f7d641">ModuleCache</a>(<a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp;&amp;)      = <span class="keyword">delete</span>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    <a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp; operator=(<a class="code" href="structchi_1_1ModuleCache.html">ModuleCache</a>&amp;&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="structchi_1_1Result.html">Result</a> <a class="code" href="structchi_1_1ModuleCache.html#acf93dc80687d0d13ebba4d3f5d215620">cacheModule</a>(<span class="keyword">const</span> boost::filesystem::path&amp; moduleName,</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;                               llvm::Module&amp; compiledModule, std::time_t timeAtFileRead) = 0;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structchi_1_1ModuleCache.html#a1da914cd290102492f3b588af705d02c">invalidateCache</a>(<span class="keyword">const</span> boost::filesystem::path&amp; moduleName) = 0;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">virtual</span> std::time_t <a class="code" href="structchi_1_1ModuleCache.html#aa46e60b79154f29101838c25d0d52ff8">cacheUpdateTime</a>(<span class="keyword">const</span> boost::filesystem::path&amp; moduleName) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keyword">virtual</span> std::unique_ptr&lt;llvm::Module&gt; <a class="code" href="structchi_1_1ModuleCache.html#a052da4f3f833549b36234932268d5e2c">retrieveFromCache</a>(</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        <span class="keyword">const</span> boost::filesystem::path&amp; moduleName, std::time_t atLeastThisNew) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structchi_1_1ModuleCache.html#a00529c4dd7aa04ffdf43689abd24f183">   59</a></span>&#160;    <a class="code" href="structchi_1_1Context.html">Context</a>&amp; <a class="code" href="structchi_1_1ModuleCache.html#a00529c4dd7aa04ffdf43689abd24f183">context</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *mContext; }</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="structchi_1_1Context.html">Context</a>* mContext;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;};</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}  <span class="comment">// namespace chi</span></div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="preprocessor">#endif  // CHI_MODULE_CACHE_HPP</span></div><div class="ttc" id="structchi_1_1ModuleCache_html_a471e0c0822bccdd1fa5ed1bc34f7d641"><div class="ttname"><a href="structchi_1_1ModuleCache.html#a471e0c0822bccdd1fa5ed1bc34f7d641">chi::ModuleCache::ModuleCache</a></div><div class="ttdeci">ModuleCache(Context &amp;ctx)</div><div class="ttdoc">Create a module cache with a bound context. </div><div class="ttdef"><b>Definition:</b> <a href="ModuleCache_8hpp_source.html#l00018">ModuleCache.hpp:18</a></div></div>
<div class="ttc" id="core_2include_2chi_2Fwd_8hpp_html"><div class="ttname"><a href="core_2include_2chi_2Fwd_8hpp.html">Fwd.hpp</a></div><div class="ttdoc">Forward declares all the chigraph data types. </div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_acf93dc80687d0d13ebba4d3f5d215620"><div class="ttname"><a href="structchi_1_1ModuleCache.html#acf93dc80687d0d13ebba4d3f5d215620">chi::ModuleCache::cacheModule</a></div><div class="ttdeci">virtual Result cacheModule(const boost::filesystem::path &amp;moduleName, llvm::Module &amp;compiledModule, std::time_t timeAtFileRead)=0</div><div class="ttdoc">Cache a module. </div></div>
<div class="ttc" id="structchi_1_1Context_html"><div class="ttname"><a href="structchi_1_1Context.html">chi::Context</a></div><div class="ttdoc">The class that handles the loading, creation, storing, and compilation of modules It also stores a LL...</div><div class="ttdef"><b>Definition:</b> <a href="Context_8hpp_source.html#l00055">Context.hpp:55</a></div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_a052da4f3f833549b36234932268d5e2c"><div class="ttname"><a href="structchi_1_1ModuleCache.html#a052da4f3f833549b36234932268d5e2c">chi::ModuleCache::retrieveFromCache</a></div><div class="ttdeci">virtual std::unique_ptr&lt; llvm::Module &gt; retrieveFromCache(const boost::filesystem::path &amp;moduleName, std::time_t atLeastThisNew)=0</div><div class="ttdoc">Retrieve a module from the cache. </div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_aa46e60b79154f29101838c25d0d52ff8"><div class="ttname"><a href="structchi_1_1ModuleCache.html#aa46e60b79154f29101838c25d0d52ff8">chi::ModuleCache::cacheUpdateTime</a></div><div class="ttdeci">virtual std::time_t cacheUpdateTime(const boost::filesystem::path &amp;moduleName) const =0</div><div class="ttdoc">Get the time that a cache was updated. </div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_a5ebdd2fe3e0835df8abfb0efe642dad3"><div class="ttname"><a href="structchi_1_1ModuleCache.html#a5ebdd2fe3e0835df8abfb0efe642dad3">chi::ModuleCache::~ModuleCache</a></div><div class="ttdeci">virtual ~ModuleCache()=default</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html"><div class="ttname"><a href="structchi_1_1ModuleCache.html">chi::ModuleCache</a></div><div class="ttdoc">This class provides an interface for creating module caches. </div><div class="ttdef"><b>Definition:</b> <a href="ModuleCache_8hpp_source.html#l00016">ModuleCache.hpp:16</a></div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_a00529c4dd7aa04ffdf43689abd24f183"><div class="ttname"><a href="structchi_1_1ModuleCache.html#a00529c4dd7aa04ffdf43689abd24f183">chi::ModuleCache::context</a></div><div class="ttdeci">Context &amp; context() const</div><div class="ttdoc">Get the context this cache is bound to. </div><div class="ttdef"><b>Definition:</b> <a href="ModuleCache_8hpp_source.html#l00059">ModuleCache.hpp:59</a></div></div>
<div class="ttc" id="namespacechi_html"><div class="ttname"><a href="namespacechi.html">chi</a></div><div class="ttdoc">The namespace where chigraph lives. </div><div class="ttdef"><b>Definition:</b> <a href="BitcodeParser_8hpp_source.html#l00012">BitcodeParser.hpp:12</a></div></div>
<div class="ttc" id="structchi_1_1Result_html"><div class="ttname"><a href="structchi_1_1Result.html">chi::Result</a></div><div class="ttdoc">The result object, used for identifiying errors with good diagnostics. </div><div class="ttdef"><b>Definition:</b> <a href="Result_8hpp_source.html#l00072">Result.hpp:72</a></div></div>
<div class="ttc" id="structchi_1_1ModuleCache_html_a1da914cd290102492f3b588af705d02c"><div class="ttname"><a href="structchi_1_1ModuleCache.html#a1da914cd290102492f3b588af705d02c">chi::ModuleCache::invalidateCache</a></div><div class="ttdeci">virtual void invalidateCache(const boost::filesystem::path &amp;moduleName)=0</div><div class="ttdoc">Inavlidate the cache, ie. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_a2d5e495f4b604d04f57d90095a59dd6.html">core</a></li><li class="navelem"><a class="el" href="dir_a979adfa99d5a8626731f83d5067598b.html">include</a></li><li class="navelem"><a class="el" href="dir_afbc2aa4d9616322ddf4041ba4f8ade6.html">chi</a></li><li class="navelem"><a class="el" href="ModuleCache_8hpp.html">ModuleCache.hpp</a></li>
    <li class="footer">Generated on Sat Sep 16 2017 17:41:35 for chigraph by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
